3 * Generic backend for the MediaWiki parser test suite, used by both the
4 * standalone parserTests.php and the PHPUnit "parsertests" suite.
6 * Copyright © 2004, 2010 Brion Vibber <brion@pobox.com>
7 * https://www.mediawiki.org/
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
24 * @todo Make this more independent of the configuration (and if possible the database)
28 use Wikimedia\Rdbms\IDatabase
;
29 use MediaWiki\MediaWikiServices
;
30 use MediaWiki\Tidy\TidyDriverBase
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\TestingAccessWrapper
;
37 class ParserTestRunner
{
40 * MediaWiki core parser test files, paths
41 * will be prefixed with __DIR__ . '/'
45 private static $coreTestFiles = [
47 'extraParserTests.txt',
51 * @var bool $useTemporaryTables Use temporary tables for the temporary database
53 private $useTemporaryTables = true;
56 * @var array $setupDone The status of each setup function
58 private $setupDone = [
59 'staticSetup' => false,
60 'perTestSetup' => false,
61 'setupDatabase' => false,
62 'setDatabase' => false,
63 'setupUploads' => false,
67 * Our connection to the database
73 * Database clone helper
86 private $tidyDriver = null;
94 * The upload directory, or null to not set up an upload directory
98 private $uploadDir = null;
101 * The name of the file backend to use, or null to use MockFileBackend.
104 private $fileBackendName;
107 * A complete regex for filtering tests.
113 * A list of normalization functions to apply to the expected and actual
117 private $normalizationFunctions = [];
120 * @param TestRecorder $recorder
121 * @param array $options
123 public function __construct( TestRecorder
$recorder, $options = [] ) {
124 $this->recorder
= $recorder;
126 if ( isset( $options['norm'] ) ) {
127 foreach ( $options['norm'] as $func ) {
128 if ( in_array( $func, [ 'removeTbody', 'trimWhitespace' ] ) ) {
129 $this->normalizationFunctions
[] = $func;
131 $this->recorder
->warning(
132 "Warning: unknown normalization option \"$func\"\n" );
137 if ( isset( $options['regex'] ) && $options['regex'] !== false ) {
138 $this->regex
= $options['regex'];
144 $this->keepUploads
= !empty( $options['keep-uploads'] );
146 $this->fileBackendName
= $options['file-backend'] ??
false;
148 $this->runDisabled
= !empty( $options['run-disabled'] );
149 $this->runParsoid
= !empty( $options['run-parsoid'] );
151 $this->tidySupport
= new TidySupport( !empty( $options['use-tidy-config'] ) );
152 if ( !$this->tidySupport
->isEnabled() ) {
153 $this->recorder
->warning(
154 "Warning: tidy is not installed, skipping some tests\n" );
157 if ( isset( $options['upload-dir'] ) ) {
158 $this->uploadDir
= $options['upload-dir'];
163 * Get list of filenames to extension and core parser tests
167 public static function getParserTestFiles() {
168 global $wgParserTestFiles;
170 // Add core test files
171 $files = array_map( function ( $item ) {
172 return __DIR__
. "/$item";
173 }, self
::$coreTestFiles );
175 // Plus legacy global files
176 $files = array_merge( $files, $wgParserTestFiles );
178 // Auto-discover extension parser tests
179 $registry = ExtensionRegistry
::getInstance();
180 foreach ( $registry->getAllThings() as $info ) {
181 $dir = dirname( $info['path'] ) . '/tests/parser';
182 if ( !file_exists( $dir ) ) {
186 $dirIterator = new RecursiveIteratorIterator(
187 new RecursiveDirectoryIterator( $dir )
189 foreach ( $dirIterator as $fileInfo ) {
190 /** @var SplFileInfo $fileInfo */
191 if ( substr( $fileInfo->getFilename(), -4 ) === '.txt' ) {
192 $name = $info['name'] . $counter;
193 while ( isset( $files[$name] ) ) {
194 $name = $info['name'] . '_' . $counter++
;
196 $files[$name] = $fileInfo->getPathname();
201 return array_unique( $files );
204 public function getRecorder() {
205 return $this->recorder
;
209 * Do any setup which can be done once for all tests, independent of test
210 * options, except for database setup.
212 * Public setup functions in this class return a ScopedCallback object. When
213 * this object is destroyed by going out of scope, teardown of the
214 * corresponding test setup is performed.
216 * Teardown objects may be chained by passing a ScopedCallback from a
217 * previous setup stage as the $nextTeardown parameter. This enforces the
218 * convention that teardown actions are taken in reverse order to the
219 * corresponding setup actions. When $nextTeardown is specified, a
220 * ScopedCallback will be returned which first tears down the current
221 * setup stage, and then tears down the previous setup stage which was
222 * specified by $nextTeardown.
224 * @param ScopedCallback|null $nextTeardown
225 * @return ScopedCallback
227 public function staticSetup( $nextTeardown = null ) {
228 // A note on coding style:
230 // The general idea here is to keep setup code together with
231 // corresponding teardown code, in a fine-grained manner. We have two
232 // arrays: $setup and $teardown. The code snippets in the $setup array
233 // are executed at the end of the method, before it returns, and the
234 // code snippets in the $teardown array are executed in reverse order
235 // when the Wikimedia\ScopedCallback object is consumed.
237 // Because it is a common operation to save, set and restore global
238 // variables, we have an additional convention: when the array key of
239 // $setup is a string, the string is taken to be the name of the global
240 // variable, and the element value is taken to be the desired new value.
242 // It's acceptable to just do the setup immediately, instead of adding
243 // a closure to $setup, except when the setup action depends on global
244 // variable initialisation being done first. In this case, you have to
245 // append a closure to $setup after the global variable is appended.
247 // When you add to setup functions in this class, please keep associated
248 // setup and teardown actions together in the source code, and please
249 // add comments explaining why the setup action is necessary.
254 $teardown[] = $this->markSetupDone( 'staticSetup' );
256 // Some settings which influence HTML output
257 $setup['wgSitename'] = 'MediaWiki';
258 $setup['wgServer'] = 'http://example.org';
259 $setup['wgServerName'] = 'example.org';
260 $setup['wgScriptPath'] = '';
261 $setup['wgScript'] = '/index.php';
262 $setup['wgResourceBasePath'] = '';
263 $setup['wgStylePath'] = '/skins';
264 $setup['wgExtensionAssetsPath'] = '/extensions';
265 $setup['wgArticlePath'] = '/wiki/$1';
266 $setup['wgActionPaths'] = [];
267 $setup['wgVariantArticlePath'] = false;
268 $setup['wgUploadNavigationUrl'] = false;
269 $setup['wgCapitalLinks'] = true;
270 $setup['wgNoFollowLinks'] = true;
271 $setup['wgNoFollowDomainExceptions'] = [ 'no-nofollow.org' ];
272 $setup['wgExternalLinkTarget'] = false;
273 $setup['wgLocaltimezone'] = 'UTC';
274 $setup['wgHtml5'] = true;
275 $setup['wgDisableLangConversion'] = false;
276 $setup['wgDisableTitleConversion'] = false;
278 // "extra language links"
279 // see https://gerrit.wikimedia.org/r/111390
280 $setup['wgExtraInterlanguageLinkPrefixes'] = [ 'mul' ];
282 // All FileRepo changes should be done here by injecting services,
283 // there should be no need to change global variables.
284 RepoGroup
::setSingleton( $this->createRepoGroup() );
285 $teardown[] = function () {
286 RepoGroup
::destroySingleton();
289 // Set up null lock managers
290 $setup['wgLockManagers'] = [ [
291 'name' => 'fsLockManager',
292 'class' => NullLockManager
::class,
294 'name' => 'nullLockManager',
295 'class' => NullLockManager
::class,
297 $reset = function () {
298 LockManagerGroup
::destroySingletons();
301 $teardown[] = $reset;
303 // This allows article insertion into the prefixed DB
304 $setup['wgDefaultExternalStore'] = false;
306 // This might slightly reduce memory usage
307 $setup['wgAdaptiveMessageCache'] = true;
309 // This is essential and overrides disabling of database messages in TestSetup
310 $setup['wgUseDatabaseMessages'] = true;
311 $reset = function () {
312 MessageCache
::destroyInstance();
315 $teardown[] = $reset;
317 // It's not necessary to actually convert any files
318 $setup['wgSVGConverter'] = 'null';
319 $setup['wgSVGConverters'] = [ 'null' => 'echo "1">$output' ];
321 // Fake constant timestamp
322 Hooks
::register( 'ParserGetVariableValueTs', function ( &$parser, &$ts ) {
323 $ts = $this->getFakeTimestamp();
326 $teardown[] = function () {
327 Hooks
::clear( 'ParserGetVariableValueTs' );
330 $this->appendNamespaceSetup( $setup, $teardown );
332 // Set up interwikis and append teardown function
333 $teardown[] = $this->setupInterwikis();
335 // This affects title normalization in links. It invalidates
336 // MediaWikiTitleCodec objects.
337 $setup['wgLocalInterwikis'] = [ 'local', 'mi' ];
338 $reset = function () {
339 $this->resetTitleServices();
342 $teardown[] = $reset;
344 // Set up a mock MediaHandlerFactory
345 MediaWikiServices
::getInstance()->disableService( 'MediaHandlerFactory' );
346 MediaWikiServices
::getInstance()->redefineService(
347 'MediaHandlerFactory',
348 function ( MediaWikiServices
$services ) {
349 $handlers = $services->getMainConfig()->get( 'ParserTestMediaHandlers' );
350 return new MediaHandlerFactory( $handlers );
353 $teardown[] = function () {
354 MediaWikiServices
::getInstance()->resetServiceForTesting( 'MediaHandlerFactory' );
357 // SqlBagOStuff broke when using temporary tables on r40209 (T17892).
358 // It seems to have been fixed since (r55079?), but regressed at some point before r85701.
359 // This works around it for now...
360 global $wgObjectCaches;
361 $setup['wgObjectCaches'] = [ CACHE_DB
=> $wgObjectCaches['hash'] ] +
$wgObjectCaches;
362 if ( isset( ObjectCache
::$instances[CACHE_DB
] ) ) {
363 $savedCache = ObjectCache
::$instances[CACHE_DB
];
364 ObjectCache
::$instances[CACHE_DB
] = new HashBagOStuff
;
365 $teardown[] = function () use ( $savedCache ) {
366 ObjectCache
::$instances[CACHE_DB
] = $savedCache;
370 $teardown[] = $this->executeSetupSnippets( $setup );
372 // Schedule teardown snippets in reverse order
373 return $this->createTeardownObject( $teardown, $nextTeardown );
376 private function appendNamespaceSetup( &$setup, &$teardown ) {
377 // Add a namespace shadowing a interwiki link, to test
378 // proper precedence when resolving links. (T53680)
379 $setup['wgExtraNamespaces'] = [
380 100 => 'MemoryAlpha',
381 101 => 'MemoryAlpha_talk'
383 // Changing wgExtraNamespaces invalidates caches in MWNamespace and
384 // any live Language object, both on setup and teardown
385 $reset = function () {
386 MWNamespace
::clearCaches();
387 $GLOBALS['wgContLang']->resetNamespaces();
390 $teardown[] = $reset;
394 * Create a RepoGroup object appropriate for the current configuration
397 protected function createRepoGroup() {
398 if ( $this->uploadDir
) {
399 if ( $this->fileBackendName
) {
400 throw new MWException( 'You cannot specify both use-filebackend and upload-dir' );
402 $backend = new FSFileBackend( [
403 'name' => 'local-backend',
404 'wikiId' => wfWikiID(),
405 'basePath' => $this->uploadDir
,
406 'tmpDirectory' => wfTempDir()
408 } elseif ( $this->fileBackendName
) {
409 global $wgFileBackends;
410 $name = $this->fileBackendName
;
412 foreach ( $wgFileBackends as $conf ) {
413 if ( $conf['name'] === $name ) {
417 if ( $useConfig === false ) {
418 throw new MWException( "Unable to find file backend \"$name\"" );
420 $useConfig['name'] = 'local-backend'; // swap name
421 unset( $useConfig['lockManager'] );
422 unset( $useConfig['fileJournal'] );
423 $class = $useConfig['class'];
424 $backend = new $class( $useConfig );
426 # Replace with a mock. We do not care about generating real
427 # files on the filesystem, just need to expose the file
429 $backend = new MockFileBackend( [
430 'name' => 'local-backend',
431 'wikiId' => wfWikiID()
435 return new RepoGroup(
437 'class' => MockLocalRepo
::class,
439 'url' => 'http://example.com/images',
441 'transformVia404' => false,
442 'backend' => $backend
449 * Execute an array in which elements with integer keys are taken to be
450 * callable objects, and other elements are taken to be global variable
451 * set operations, with the key giving the variable name and the value
452 * giving the new global variable value. A closure is returned which, when
453 * executed, sets the global variables back to the values they had before
454 * this function was called.
458 * @param array $setup
461 protected function executeSetupSnippets( $setup ) {
463 foreach ( $setup as $name => $value ) {
464 if ( is_int( $name ) ) {
467 $saved[$name] = $GLOBALS[$name] ??
null;
468 $GLOBALS[$name] = $value;
471 return function () use ( $saved ) {
472 $this->executeSetupSnippets( $saved );
477 * Take a setup array in the same format as the one given to
478 * executeSetupSnippets(), and return a ScopedCallback which, when consumed,
479 * executes the snippets in the setup array in reverse order. This is used
480 * to create "teardown objects" for the public API.
484 * @param array $teardown The snippet array
485 * @param ScopedCallback|null $nextTeardown A ScopedCallback to consume
486 * @return ScopedCallback
488 protected function createTeardownObject( $teardown, $nextTeardown = null ) {
489 return new ScopedCallback( function () use ( $teardown, $nextTeardown ) {
490 // Schedule teardown snippets in reverse order
491 $teardown = array_reverse( $teardown );
493 $this->executeSetupSnippets( $teardown );
494 if ( $nextTeardown ) {
495 ScopedCallback
::consume( $nextTeardown );
501 * Set a setupDone flag to indicate that setup has been done, and return
502 * the teardown closure. If the flag was already set, throw an exception.
504 * @param string $funcName The setup function name
507 protected function markSetupDone( $funcName ) {
508 if ( $this->setupDone
[$funcName] ) {
509 throw new MWException( "$funcName is already done" );
511 $this->setupDone
[$funcName] = true;
512 return function () use ( $funcName ) {
513 $this->setupDone
[$funcName] = false;
518 * Ensure a given setup stage has been done, throw an exception if it has
520 * @param string $funcName
521 * @param string|null $funcName2
523 protected function checkSetupDone( $funcName, $funcName2 = null ) {
524 if ( !$this->setupDone
[$funcName]
525 && ( $funcName === null ||
!$this->setupDone
[$funcName2] )
527 throw new MWException( "$funcName must be called before calling " .
533 * Determine whether a particular setup function has been run
535 * @param string $funcName
538 public function isSetupDone( $funcName ) {
539 return $this->setupDone
[$funcName] ??
false;
543 * Insert hardcoded interwiki in the lookup table.
545 * This function insert a set of well known interwikis that are used in
546 * the parser tests. They can be considered has fixtures are injected in
547 * the interwiki cache by using the 'InterwikiLoadPrefix' hook.
548 * Since we are not interested in looking up interwikis in the database,
549 * the hook completely replace the existing mechanism (hook returns false).
551 * @return closure for teardown
553 private function setupInterwikis() {
554 # Hack: insert a few Wikipedia in-project interwiki prefixes,
555 # for testing inter-language links
556 Hooks
::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) {
557 static $testInterwikis = [
559 'iw_url' => 'http://doesnt.matter.org/$1',
564 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
569 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
574 'iw_url' => 'http://www.memory-alpha.org/en/index.php/$1',
579 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
584 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
589 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
594 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
599 'iw_url' => 'http://mi.wikipedia.org/wiki/$1',
604 'iw_url' => 'http://wikisource.org/wiki/$1',
609 if ( array_key_exists( $prefix, $testInterwikis ) ) {
610 $iwData = $testInterwikis[$prefix];
613 // We only want to rely on the above fixtures
615 } );// hooks::register
617 // Reset the service in case any other tests already cached some prefixes.
618 MediaWikiServices
::getInstance()->resetServiceForTesting( 'InterwikiLookup' );
622 Hooks
::clear( 'InterwikiLoadPrefix' );
623 MediaWikiServices
::getInstance()->resetServiceForTesting( 'InterwikiLookup' );
628 * Reset the Title-related services that need resetting
631 private function resetTitleServices() {
632 $services = MediaWikiServices
::getInstance();
633 $services->resetServiceForTesting( 'TitleFormatter' );
634 $services->resetServiceForTesting( 'TitleParser' );
635 $services->resetServiceForTesting( '_MediaWikiTitleCodec' );
636 $services->resetServiceForTesting( 'LinkRenderer' );
637 $services->resetServiceForTesting( 'LinkRendererFactory' );
641 * Remove last character if it is a newline
645 public static function chomp( $s ) {
646 if ( substr( $s, -1 ) === "\n" ) {
647 return substr( $s, 0, -1 );
654 * Run a series of tests listed in the given text files.
655 * Each test consists of a brief description, wikitext input,
656 * and the expected HTML output.
658 * Prints status updates on stdout and counts up the total
659 * number and percentage of passed tests.
661 * Handles all setup and teardown.
663 * @param array $filenames Array of strings
664 * @return bool True if passed all tests, false if any tests failed.
666 public function runTestsFromFiles( $filenames ) {
669 $teardownGuard = $this->staticSetup();
670 $teardownGuard = $this->setupDatabase( $teardownGuard );
671 $teardownGuard = $this->setupUploads( $teardownGuard );
673 $this->recorder
->start();
677 foreach ( $filenames as $filename ) {
678 $testFileInfo = TestFileReader
::read( $filename, [
679 'runDisabled' => $this->runDisabled
,
680 'runParsoid' => $this->runParsoid
,
681 'regex' => $this->regex
] );
683 // Don't start the suite if there are no enabled tests in the file
684 if ( !$testFileInfo['tests'] ) {
688 $this->recorder
->startSuite( $filename );
689 $ok = $this->runTests( $testFileInfo ) && $ok;
690 $this->recorder
->endSuite( $filename );
693 $this->recorder
->report();
694 } catch ( DBError
$e ) {
695 $this->recorder
->warning( $e->getMessage() );
697 $this->recorder
->end();
699 ScopedCallback
::consume( $teardownGuard );
705 * Determine whether the current parser has the hooks registered in it
706 * that are required by a file read by TestFileReader.
707 * @param array $requirements
710 public function meetsRequirements( $requirements ) {
711 foreach ( $requirements as $requirement ) {
712 switch ( $requirement['type'] ) {
714 $ok = $this->requireHook( $requirement['name'] );
717 $ok = $this->requireFunctionHook( $requirement['name'] );
719 case 'transparentHook':
720 $ok = $this->requireTransparentHook( $requirement['name'] );
731 * Run the tests from a single file. staticSetup() and setupDatabase()
732 * must have been called already.
734 * @param array $testFileInfo Parsed file info returned by TestFileReader
735 * @return bool True if passed all tests, false if any tests failed.
737 public function runTests( $testFileInfo ) {
740 $this->checkSetupDone( 'staticSetup' );
742 // Don't add articles from the file if there are no enabled tests from the file
743 if ( !$testFileInfo['tests'] ) {
747 // If any requirements are not met, mark all tests from the file as skipped
748 if ( !$this->meetsRequirements( $testFileInfo['requirements'] ) ) {
749 foreach ( $testFileInfo['tests'] as $test ) {
750 $this->recorder
->startTest( $test );
751 $this->recorder
->skipped( $test, 'required extension not enabled' );
757 $this->addArticles( $testFileInfo['articles'] );
760 foreach ( $testFileInfo['tests'] as $test ) {
761 $this->recorder
->startTest( $test );
763 $this->runTest( $test );
764 if ( $result !== false ) {
765 $ok = $ok && $result->isSuccess();
766 $this->recorder
->record( $test, $result );
774 * Get a Parser object
776 * @param string $preprocessor
779 function getParser( $preprocessor = null ) {
780 global $wgParserConf;
782 $class = $wgParserConf['class'];
783 $parser = new $class( [ 'preprocessorClass' => $preprocessor ] +
$wgParserConf );
784 ParserTestParserHook
::setup( $parser );
790 * Run a given wikitext input through a freshly-constructed wiki parser,
791 * and compare the output against the expected results.
792 * Prints status and explanatory messages to stdout.
794 * staticSetup() and setupWikiData() must be called before this function
797 * @param array $test The test parameters:
798 * - test: The test name
799 * - desc: The subtest description
800 * - input: Wikitext to try rendering
801 * - options: Array of test options
802 * - config: Overrides for global variables, one per line
804 * @return ParserTestResult|false false if skipped
806 public function runTest( $test ) {
807 wfDebug( __METHOD__
.": running {$test['desc']}" );
808 $opts = $this->parseOptions( $test['options'] );
809 $teardownGuard = $this->perTestSetup( $test );
811 $context = RequestContext
::getMain();
812 $user = $context->getUser();
813 $options = ParserOptions
::newFromContext( $context );
814 $options->setTimestamp( $this->getFakeTimestamp() );
816 if ( isset( $opts['tidy'] ) ) {
817 if ( !$this->tidySupport
->isEnabled() ) {
818 $this->recorder
->skipped( $test, 'tidy extension is not installed' );
821 $options->setTidy( true );
825 if ( isset( $opts['title'] ) ) {
826 $titleText = $opts['title'];
828 $titleText = 'Parser test';
831 if ( isset( $opts['maxincludesize'] ) ) {
832 $options->setMaxIncludeSize( $opts['maxincludesize'] );
834 if ( isset( $opts['maxtemplatedepth'] ) ) {
835 $options->setMaxTemplateDepth( $opts['maxtemplatedepth'] );
838 $local = isset( $opts['local'] );
839 $preprocessor = $opts['preprocessor'] ??
null;
840 $parser = $this->getParser( $preprocessor );
841 $title = Title
::newFromText( $titleText );
843 if ( isset( $opts['styletag'] ) ) {
844 // For testing the behavior of <style> (including those deduplicated
845 // into <link> tags), add tag hooks to allow them to be generated.
846 $parser->setHook( 'style', function ( $content, $attributes, $parser ) {
847 $marker = Parser
::MARKER_PREFIX
. '-style-' . md5( $content ) . Parser
::MARKER_SUFFIX
;
848 $parser->mStripState
->addNoWiki( $marker, $content );
849 return Html
::inlineStyle( $marker, 'all', $attributes );
851 $parser->setHook( 'link', function ( $content, $attributes, $parser ) {
852 return Html
::element( 'link', $attributes );
856 if ( isset( $opts['pst'] ) ) {
857 $out = $parser->preSaveTransform( $test['input'], $title, $user, $options );
858 $output = $parser->getOutput();
859 } elseif ( isset( $opts['msg'] ) ) {
860 $out = $parser->transformMsg( $test['input'], $options, $title );
861 } elseif ( isset( $opts['section'] ) ) {
862 $section = $opts['section'];
863 $out = $parser->getSection( $test['input'], $section );
864 } elseif ( isset( $opts['replace'] ) ) {
865 $section = $opts['replace'][0];
866 $replace = $opts['replace'][1];
867 $out = $parser->replaceSection( $test['input'], $section, $replace );
868 } elseif ( isset( $opts['comment'] ) ) {
869 $out = Linker
::formatComment( $test['input'], $title, $local );
870 } elseif ( isset( $opts['preload'] ) ) {
871 $out = $parser->getPreloadText( $test['input'], $title, $options );
873 $output = $parser->parse( $test['input'], $title, $options, true, true, 1337 );
874 $out = $output->getText( [
875 'allowTOC' => !isset( $opts['notoc'] ),
876 'unwrap' => !isset( $opts['wrap'] ),
878 if ( isset( $opts['tidy'] ) ) {
879 $out = preg_replace( '/\s+$/', '', $out );
882 if ( isset( $opts['showtitle'] ) ) {
883 if ( $output->getTitleText() ) {
884 $title = $output->getTitleText();
887 $out = "$title\n$out";
890 if ( isset( $opts['showindicators'] ) ) {
892 foreach ( $output->getIndicators() as $id => $content ) {
893 $indicators .= "$id=$content\n";
895 $out = $indicators . $out;
898 if ( isset( $opts['ill'] ) ) {
899 $out = implode( ' ', $output->getLanguageLinks() );
900 } elseif ( isset( $opts['cat'] ) ) {
902 foreach ( $output->getCategories() as $name => $sortkey ) {
906 $out .= "cat=$name sort=$sortkey";
911 if ( isset( $output ) && isset( $opts['showflags'] ) ) {
912 $actualFlags = array_keys( TestingAccessWrapper
::newFromObject( $output )->mFlags
);
913 sort( $actualFlags );
914 $out .= "\nflags=" . implode( ', ', $actualFlags );
917 ScopedCallback
::consume( $teardownGuard );
919 $expected = $test['result'];
920 if ( count( $this->normalizationFunctions
) ) {
921 $expected = ParserTestResultNormalizer
::normalize(
922 $test['expected'], $this->normalizationFunctions
);
923 $out = ParserTestResultNormalizer
::normalize( $out, $this->normalizationFunctions
);
926 $testResult = new ParserTestResult( $test, $expected, $out );
931 * Use a regex to find out the value of an option
932 * @param string $key Name of option val to retrieve
933 * @param array $opts Options array to look in
934 * @param mixed $default Default value returned if not found
937 private static function getOptionValue( $key, $opts, $default ) {
938 $key = strtolower( $key );
940 if ( isset( $opts[$key] ) ) {
948 * Given the options string, return an associative array of options.
949 * @todo Move this to TestFileReader
951 * @param string $instring
954 private function parseOptions( $instring ) {
960 // foo=bar,"baz quux"
963 (?<qstr> # Quoted string
965 (?:[^\\\\"] | \\\\.)*
971 [^"{}] | # Not a quoted string or object, or
972 (?&qstr) | # A quoted string, or
973 (?&json) # A json object (recursively)
979 (?&qstr) # Quoted val
987 (?&json) # JSON object
991 $regex = '/' . $defs . '\b
1007 $valueregex = '/' . $defs . '(?&value)/x';
1009 if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER
) ) {
1010 foreach ( $matches as $bits ) {
1011 $key = strtolower( $bits['k'] );
1012 if ( !isset( $bits['v'] ) ) {
1015 preg_match_all( $valueregex, $bits['v'], $vmatches );
1016 $opts[$key] = array_map( [ $this, 'cleanupOption' ], $vmatches[0] );
1017 if ( count( $opts[$key] ) == 1 ) {
1018 $opts[$key] = $opts[$key][0];
1026 private function cleanupOption( $opt ) {
1027 if ( substr( $opt, 0, 1 ) == '"' ) {
1028 return stripcslashes( substr( $opt, 1, -1 ) );
1031 if ( substr( $opt, 0, 2 ) == '[[' ) {
1032 return substr( $opt, 2, -2 );
1035 if ( substr( $opt, 0, 1 ) == '{' ) {
1036 return FormatJson
::decode( $opt, true );
1042 * Do any required setup which is dependent on test options.
1044 * @see staticSetup() for more information about setup/teardown
1046 * @param array $test Test info supplied by TestFileReader
1047 * @param callable|null $nextTeardown
1048 * @return ScopedCallback
1050 public function perTestSetup( $test, $nextTeardown = null ) {
1053 $this->checkSetupDone( 'setupDatabase', 'setDatabase' );
1054 $teardown[] = $this->markSetupDone( 'perTestSetup' );
1056 $opts = $this->parseOptions( $test['options'] );
1057 $config = $test['config'];
1059 // Find out values for some special options.
1061 self
::getOptionValue( 'language', $opts, 'en' );
1063 self
::getOptionValue( 'variant', $opts, false );
1065 self
::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
1066 $linkHolderBatchSize =
1067 self
::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
1069 // Default to fallback skin, but allow it to be overridden
1070 $skin = self
::getOptionValue( 'skin', $opts, 'fallback' );
1073 'wgEnableUploads' => self
::getOptionValue( 'wgEnableUploads', $opts, true ),
1074 'wgLanguageCode' => $langCode,
1075 'wgRawHtml' => self
::getOptionValue( 'wgRawHtml', $opts, false ),
1076 'wgNamespacesWithSubpages' => array_fill_keys(
1077 MWNamespace
::getValidNamespaces(), isset( $opts['subpage'] )
1079 'wgMaxTocLevel' => $maxtoclevel,
1080 'wgAllowExternalImages' => self
::getOptionValue( 'wgAllowExternalImages', $opts, true ),
1081 'wgThumbLimits' => [ self
::getOptionValue( 'thumbsize', $opts, 180 ) ],
1082 'wgDefaultLanguageVariant' => $variant,
1083 'wgLinkHolderBatchSize' => $linkHolderBatchSize,
1084 // Set as a JSON object like:
1085 // wgEnableMagicLinks={"ISBN":false, "PMID":false, "RFC":false}
1086 'wgEnableMagicLinks' => self
::getOptionValue( 'wgEnableMagicLinks', $opts, [] )
1087 +
[ 'ISBN' => true, 'PMID' => true, 'RFC' => true ],
1088 // Test with legacy encoding by default until HTML5 is very stable and default
1089 'wgFragmentMode' => [ 'legacy' ],
1092 $nonIncludable = self
::getOptionValue( 'wgNonincludableNamespaces', $opts, false );
1093 if ( $nonIncludable !== false ) {
1094 $setup['wgNonincludableNamespaces'] = [ $nonIncludable ];
1098 $configLines = explode( "\n", $config );
1100 foreach ( $configLines as $line ) {
1101 list( $var, $value ) = explode( '=', $line, 2 );
1102 $setup[$var] = eval( "return $value;" );
1107 Hooks
::run( 'ParserTestGlobals', [ &$setup ] );
1109 // Create tidy driver
1110 if ( isset( $opts['tidy'] ) ) {
1111 // Cache a driver instance
1112 if ( $this->tidyDriver
=== null ) {
1113 $this->tidyDriver
= MWTidy
::factory( $this->tidySupport
->getConfig() );
1115 $tidy = $this->tidyDriver
;
1119 MWTidy
::setInstance( $tidy );
1120 $teardown[] = function () {
1121 MWTidy
::destroySingleton();
1124 // Set content language. This invalidates the magic word cache and title services
1125 $lang = Language
::factory( $langCode );
1126 $lang->resetNamespaces();
1127 $setup['wgContLang'] = $lang;
1128 $reset = function () {
1129 MagicWord
::clearCache();
1130 $this->resetTitleServices();
1133 $teardown[] = $reset;
1135 // Make a user object with the same language
1137 $user->setOption( 'language', $langCode );
1138 $setup['wgLang'] = $lang;
1140 // We (re)set $wgThumbLimits to a single-element array above.
1141 $user->setOption( 'thumbsize', 0 );
1143 $setup['wgUser'] = $user;
1145 // And put both user and language into the context
1146 $context = RequestContext
::getMain();
1147 $context->setUser( $user );
1148 $context->setLanguage( $lang );
1150 $oldSkin = $context->getSkin();
1151 $skinFactory = MediaWikiServices
::getInstance()->getSkinFactory();
1152 $context->setSkin( $skinFactory->makeSkin( $skin ) );
1153 $context->setOutput( new OutputPage( $context ) );
1154 $setup['wgOut'] = $context->getOutput();
1155 $teardown[] = function () use ( $context, $oldSkin ) {
1156 // Clear language conversion tables
1157 $wrapper = TestingAccessWrapper
::newFromObject(
1158 $context->getLanguage()->getConverter()
1160 $wrapper->reloadTables();
1161 // Reset context to the restored globals
1162 $context->setUser( $GLOBALS['wgUser'] );
1163 $context->setLanguage( $GLOBALS['wgContLang'] );
1164 $context->setSkin( $oldSkin );
1165 $context->setOutput( $GLOBALS['wgOut'] );
1168 $teardown[] = $this->executeSetupSnippets( $setup );
1170 return $this->createTeardownObject( $teardown, $nextTeardown );
1174 * List of temporary tables to create, without prefix.
1175 * Some of these probably aren't necessary.
1178 private function listTables() {
1179 global $wgCommentTableSchemaMigrationStage, $wgActorTableSchemaMigrationStage;
1181 $tables = [ 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions',
1182 'protected_titles', 'revision', 'ip_changes', 'text', 'pagelinks', 'imagelinks',
1183 'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks',
1184 'site_stats', 'ipblocks', 'image', 'oldimage',
1185 'recentchanges', 'watchlist', 'interwiki', 'logging', 'log_search',
1186 'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
1187 'archive', 'user_groups', 'page_props', 'category'
1190 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
1191 // The new tables for comments are in use
1192 $tables[] = 'comment';
1193 $tables[] = 'revision_comment_temp';
1194 $tables[] = 'image_comment_temp';
1197 if ( $wgActorTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
1198 // The new tables for actors are in use
1199 $tables[] = 'actor';
1200 $tables[] = 'revision_actor_temp';
1203 if ( in_array( $this->db
->getType(), [ 'mysql', 'sqlite', 'oracle' ] ) ) {
1204 array_push( $tables, 'searchindex' );
1207 // Allow extensions to add to the list of tables to duplicate;
1208 // may be necessary if they hook into page save or other code
1209 // which will require them while running tests.
1210 Hooks
::run( 'ParserTestTables', [ &$tables ] );
1215 public function setDatabase( IDatabase
$db ) {
1217 $this->setupDone
['setDatabase'] = true;
1221 * Set up temporary DB tables.
1223 * For best performance, call this once only for all tests. However, it can
1224 * be called at the start of each test if more isolation is desired.
1226 * @todo: This is basically an unrefactored copy of
1227 * MediaWikiTestCase::setupAllTestDBs. They should be factored out somehow.
1229 * Do not call this function from a MediaWikiTestCase subclass, since
1230 * MediaWikiTestCase does its own DB setup. Instead use setDatabase().
1232 * @see staticSetup() for more information about setup/teardown
1234 * @param ScopedCallback|null $nextTeardown The next teardown object
1235 * @return ScopedCallback The teardown object
1237 public function setupDatabase( $nextTeardown = null ) {
1240 $this->db
= wfGetDB( DB_MASTER
);
1241 $dbType = $this->db
->getType();
1243 if ( $dbType == 'oracle' ) {
1244 $suspiciousPrefixes = [ 'pt_', MediaWikiTestCase
::ORA_DB_PREFIX
];
1246 $suspiciousPrefixes = [ 'parsertest_', MediaWikiTestCase
::DB_PREFIX
];
1248 if ( in_array( $wgDBprefix, $suspiciousPrefixes ) ) {
1249 throw new MWException( "\$wgDBprefix=$wgDBprefix suggests DB setup is already done" );
1254 $teardown[] = $this->markSetupDone( 'setupDatabase' );
1256 # CREATE TEMPORARY TABLE breaks if there is more than one server
1257 if ( MediaWikiServices
::getInstance()->getDBLoadBalancer()->getServerCount() != 1 ) {
1258 $this->useTemporaryTables
= false;
1261 $temporary = $this->useTemporaryTables ||
$dbType == 'postgres';
1262 $prefix = $dbType != 'oracle' ?
'parsertest_' : 'pt_';
1264 $this->dbClone
= new CloneDatabase( $this->db
, $this->listTables(), $prefix );
1265 $this->dbClone
->useTemporaryTables( $temporary );
1266 $this->dbClone
->cloneTableStructure();
1268 if ( $dbType == 'oracle' ) {
1269 $this->db
->query( 'BEGIN FILL_WIKI_INFO; END;' );
1270 # Insert 0 user to prevent FK violations
1273 $this->db
->insert( 'user', [
1275 'user_name' => 'Anonymous' ] );
1278 $teardown[] = function () {
1279 $this->teardownDatabase();
1282 // Wipe some DB query result caches on setup and teardown
1283 $reset = function () {
1284 LinkCache
::singleton()->clear();
1286 // Clear the message cache
1287 MessageCache
::singleton()->clear();
1290 $teardown[] = $reset;
1291 return $this->createTeardownObject( $teardown, $nextTeardown );
1295 * Add data about uploads to the new test DB, and set up the upload
1296 * directory. This should be called after either setDatabase() or
1299 * @param ScopedCallback|null $nextTeardown The next teardown object
1300 * @return ScopedCallback The teardown object
1302 public function setupUploads( $nextTeardown = null ) {
1305 $this->checkSetupDone( 'setupDatabase', 'setDatabase' );
1306 $teardown[] = $this->markSetupDone( 'setupUploads' );
1308 // Create the files in the upload directory (or pretend to create them
1309 // in a MockFileBackend). Append teardown callback.
1310 $teardown[] = $this->setupUploadBackend();
1313 $user = User
::createNew( 'WikiSysop' );
1315 // Register the uploads in the database
1317 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Foobar.jpg' ) );
1318 # note that the size/width/height/bits/etc of the file
1319 # are actually set by inspecting the file itself; the arguments
1320 # to recordUpload2 have no effect. That said, we try to make things
1321 # match up so it is less confusing to readers of the code & tests.
1322 $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', [
1327 'media_type' => MEDIATYPE_BITMAP
,
1328 'mime' => 'image/jpeg',
1329 'metadata' => serialize( [] ),
1330 'sha1' => Wikimedia\base_convert
( '1', 16, 36, 31 ),
1331 'fileExists' => true
1332 ], $this->db
->timestamp( '20010115123500' ), $user );
1334 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Thumb.png' ) );
1335 # again, note that size/width/height below are ignored; see above.
1336 $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', [
1341 'media_type' => MEDIATYPE_BITMAP
,
1342 'mime' => 'image/png',
1343 'metadata' => serialize( [] ),
1344 'sha1' => Wikimedia\base_convert
( '2', 16, 36, 31 ),
1345 'fileExists' => true
1346 ], $this->db
->timestamp( '20130225203040' ), $user );
1348 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Foobar.svg' ) );
1349 $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', [
1354 'media_type' => MEDIATYPE_DRAWING
,
1355 'mime' => 'image/svg+xml',
1356 'metadata' => serialize( [] ),
1357 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1358 'fileExists' => true
1359 ], $this->db
->timestamp( '20010115123500' ), $user );
1361 # This image will be blacklisted in [[MediaWiki:Bad image list]]
1362 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Bad.jpg' ) );
1363 $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', [
1368 'media_type' => MEDIATYPE_BITMAP
,
1369 'mime' => 'image/jpeg',
1370 'metadata' => serialize( [] ),
1371 'sha1' => Wikimedia\base_convert
( '3', 16, 36, 31 ),
1372 'fileExists' => true
1373 ], $this->db
->timestamp( '20010115123500' ), $user );
1375 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Video.ogv' ) );
1376 $image->recordUpload2( '', 'A pretty movie', 'Will it play', [
1381 'media_type' => MEDIATYPE_VIDEO
,
1382 'mime' => 'application/ogg',
1383 'metadata' => serialize( [] ),
1384 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1385 'fileExists' => true
1386 ], $this->db
->timestamp( '20010115123500' ), $user );
1388 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Audio.oga' ) );
1389 $image->recordUpload2( '', 'An awesome hitsong', 'Will it play', [
1394 'media_type' => MEDIATYPE_AUDIO
,
1395 'mime' => 'application/ogg',
1396 'metadata' => serialize( [] ),
1397 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1398 'fileExists' => true
1399 ], $this->db
->timestamp( '20010115123500' ), $user );
1402 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'LoremIpsum.djvu' ) );
1403 $image->recordUpload2( '', 'Upload a DjVu', 'A DjVu', [
1408 'media_type' => MEDIATYPE_BITMAP
,
1409 'mime' => 'image/vnd.djvu',
1410 'metadata' => '<?xml version="1.0" ?>
1411 <!DOCTYPE DjVuXML PUBLIC "-//W3C//DTD DjVuXML 1.1//EN" "pubtext/DjVuXML-s.dtd">
1414 <BODY><OBJECT height="3508" width="2480">
1415 <PARAM name="DPI" value="300" />
1416 <PARAM name="GAMMA" value="2.2" />
1418 <OBJECT height="3508" width="2480">
1419 <PARAM name="DPI" value="300" />
1420 <PARAM name="GAMMA" value="2.2" />
1422 <OBJECT height="3508" width="2480">
1423 <PARAM name="DPI" value="300" />
1424 <PARAM name="GAMMA" value="2.2" />
1426 <OBJECT height="3508" width="2480">
1427 <PARAM name="DPI" value="300" />
1428 <PARAM name="GAMMA" value="2.2" />
1430 <OBJECT height="3508" width="2480">
1431 <PARAM name="DPI" value="300" />
1432 <PARAM name="GAMMA" value="2.2" />
1436 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1437 'fileExists' => true
1438 ], $this->db
->timestamp( '20010115123600' ), $user );
1440 return $this->createTeardownObject( $teardown, $nextTeardown );
1444 * Helper for database teardown, called from the teardown closure. Destroy
1445 * the database clone and fix up some things that CloneDatabase doesn't fix.
1447 * @todo Move most things here to CloneDatabase
1449 private function teardownDatabase() {
1450 $this->checkSetupDone( 'setupDatabase' );
1452 $this->dbClone
->destroy();
1453 $this->databaseSetupDone
= false;
1455 if ( $this->useTemporaryTables
) {
1456 if ( $this->db
->getType() == 'sqlite' ) {
1457 # Under SQLite the searchindex table is virtual and need
1458 # to be explicitly destroyed. See T31912
1459 # See also MediaWikiTestCase::destroyDB()
1460 wfDebug( __METHOD__
. " explicitly destroying sqlite virtual table parsertest_searchindex\n" );
1461 $this->db
->query( "DROP TABLE `parsertest_searchindex`" );
1463 # Don't need to do anything
1467 $tables = $this->listTables();
1469 foreach ( $tables as $table ) {
1470 if ( $this->db
->getType() == 'oracle' ) {
1471 $this->db
->query( "DROP TABLE pt_$table DROP CONSTRAINTS" );
1473 $this->db
->query( "DROP TABLE `parsertest_$table`" );
1477 if ( $this->db
->getType() == 'oracle' ) {
1478 $this->db
->query( 'BEGIN FILL_WIKI_INFO; END;' );
1483 * Upload test files to the backend created by createRepoGroup().
1485 * @return callable The teardown callback
1487 private function setupUploadBackend() {
1490 $repo = RepoGroup
::singleton()->getLocalRepo();
1491 $base = $repo->getZonePath( 'public' );
1492 $backend = $repo->getBackend();
1493 $backend->prepare( [ 'dir' => "$base/3/3a" ] );
1495 'src' => "$IP/tests/phpunit/data/parser/headbg.jpg",
1496 'dst' => "$base/3/3a/Foobar.jpg"
1498 $backend->prepare( [ 'dir' => "$base/e/ea" ] );
1500 'src' => "$IP/tests/phpunit/data/parser/wiki.png",
1501 'dst' => "$base/e/ea/Thumb.png"
1503 $backend->prepare( [ 'dir' => "$base/0/09" ] );
1505 'src' => "$IP/tests/phpunit/data/parser/headbg.jpg",
1506 'dst' => "$base/0/09/Bad.jpg"
1508 $backend->prepare( [ 'dir' => "$base/5/5f" ] );
1510 'src' => "$IP/tests/phpunit/data/parser/LoremIpsum.djvu",
1511 'dst' => "$base/5/5f/LoremIpsum.djvu"
1514 // No helpful SVG file to copy, so make one ourselves
1515 $data = '<?xml version="1.0" encoding="utf-8"?>' .
1516 '<svg xmlns="http://www.w3.org/2000/svg"' .
1517 ' version="1.1" width="240" height="180"/>';
1519 $backend->prepare( [ 'dir' => "$base/f/ff" ] );
1520 $backend->quickCreate( [
1521 'content' => $data, 'dst' => "$base/f/ff/Foobar.svg"
1524 return function () use ( $backend ) {
1525 if ( $backend instanceof MockFileBackend
) {
1526 // In memory backend, so dont bother cleaning them up.
1529 $this->teardownUploadBackend();
1534 * Remove the dummy uploads directory
1536 private function teardownUploadBackend() {
1537 if ( $this->keepUploads
) {
1541 $repo = RepoGroup
::singleton()->getLocalRepo();
1542 $public = $repo->getZonePath( 'public' );
1546 "$public/3/3a/Foobar.jpg",
1547 "$public/e/ea/Thumb.png",
1548 "$public/0/09/Bad.jpg",
1549 "$public/5/5f/LoremIpsum.djvu",
1550 "$public/f/ff/Foobar.svg",
1551 "$public/0/00/Video.ogv",
1552 "$public/4/41/Audio.oga",
1558 * Delete the specified files and their parent directories
1559 * @param array $files File backend URIs mwstore://...
1561 private function deleteFiles( $files ) {
1563 $backend = RepoGroup
::singleton()->getLocalRepo()->getBackend();
1564 foreach ( $files as $file ) {
1565 $backend->delete( [ 'src' => $file ], [ 'force' => 1 ] );
1568 // Delete the parent directories
1569 foreach ( $files as $file ) {
1570 $tmp = FileBackend
::parentStoragePath( $file );
1572 if ( !$backend->clean( [ 'dir' => $tmp ] )->isOK() ) {
1575 $tmp = FileBackend
::parentStoragePath( $tmp );
1581 * Add articles to the test DB.
1583 * @param array $articles Article info array from TestFileReader
1585 public function addArticles( $articles ) {
1590 // Be sure ParserTestRunner::addArticle has correct language set,
1591 // so that system messages get into the right language cache
1592 if ( $wgContLang->getCode() !== 'en' ) {
1593 $setup['wgLanguageCode'] = 'en';
1594 $setup['wgContLang'] = Language
::factory( 'en' );
1597 // Add special namespaces, in case that hasn't been done by staticSetup() yet
1598 $this->appendNamespaceSetup( $setup, $teardown );
1600 // wgCapitalLinks obviously needs initialisation
1601 $setup['wgCapitalLinks'] = true;
1603 $teardown[] = $this->executeSetupSnippets( $setup );
1605 foreach ( $articles as $info ) {
1606 $this->addArticle( $info['name'], $info['text'], $info['file'], $info['line'] );
1609 // Wipe WANObjectCache process cache, which is invalidated by article insertion
1611 ObjectCache
::getMainWANInstance()->clearProcessCache();
1613 $this->executeSetupSnippets( $teardown );
1617 * Insert a temporary test article
1618 * @param string $name The title, including any prefix
1619 * @param string $text The article text
1620 * @param string $file The input file name
1621 * @param int|string $line The input line number, for reporting errors
1623 * @throws MWException
1625 private function addArticle( $name, $text, $file, $line ) {
1626 $text = self
::chomp( $text );
1627 $name = self
::chomp( $name );
1629 $title = Title
::newFromText( $name );
1630 wfDebug( __METHOD__
. ": adding $name" );
1632 if ( is_null( $title ) ) {
1633 throw new MWException( "invalid title '$name' at $file:$line\n" );
1636 $newContent = ContentHandler
::makeContent( $text, $title );
1638 $page = WikiPage
::factory( $title );
1639 $page->loadPageData( 'fromdbmaster' );
1641 if ( $page->exists() ) {
1642 $content = $page->getContent( Revision
::RAW
);
1643 // Only reject the title, if the content/content model is different.
1644 // This makes it easier to create Template:(( or Template:)) in different extensions
1645 if ( $newContent->equals( $content ) ) {
1648 throw new MWException(
1649 "duplicate article '$name' with different content at $file:$line\n"
1653 // Use mock parser, to make debugging of actual parser tests simpler.
1654 // But initialise the MessageCache clone first, don't let MessageCache
1655 // get a reference to the mock object.
1656 MessageCache
::singleton()->getParser();
1657 $restore = $this->executeSetupSnippets( [ 'wgParser' => new ParserTestMockParser
] );
1659 $status = $page->doEditContent(
1662 EDIT_NEW | EDIT_INTERNAL
1668 if ( !$status->isOK() ) {
1669 throw new MWException( $status->getWikiText( false, false, 'en' ) );
1672 // The RepoGroup cache is invalidated by the creation of file redirects
1673 if ( $title->inNamespace( NS_FILE
) ) {
1674 RepoGroup
::singleton()->clearCache( $title );
1679 * Check if a hook is installed
1681 * @param string $name
1682 * @return bool True if tag hook is present
1684 public function requireHook( $name ) {
1687 $wgParser->firstCallInit(); // make sure hooks are loaded.
1688 if ( isset( $wgParser->mTagHooks
[$name] ) ) {
1691 $this->recorder
->warning( " This test suite requires the '$name' hook " .
1692 "extension, skipping." );
1698 * Check if a function hook is installed
1700 * @param string $name
1701 * @return bool True if function hook is present
1703 public function requireFunctionHook( $name ) {
1706 $wgParser->firstCallInit(); // make sure hooks are loaded.
1708 if ( isset( $wgParser->mFunctionHooks
[$name] ) ) {
1711 $this->recorder
->warning( " This test suite requires the '$name' function " .
1712 "hook extension, skipping." );
1718 * Check if a transparent tag hook is installed
1720 * @param string $name
1721 * @return bool True if function hook is present
1723 public function requireTransparentHook( $name ) {
1726 $wgParser->firstCallInit(); // make sure hooks are loaded.
1728 if ( isset( $wgParser->mTransparentTagHooks
[$name] ) ) {
1731 $this->recorder
->warning( " This test suite requires the '$name' transparent " .
1732 "hook extension, skipping.\n" );
1738 * Fake constant timestamp to make sure time-related parser
1739 * functions give a persistent value.
1741 * - Parser::getVariableValue (via ParserGetVariableValueTs hook)
1742 * - Parser::preSaveTransform (via ParserOptions)
1744 private function getFakeTimestamp() {
1745 // parsed as '1970-01-01T00:02:03Z'